<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2011 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: ExceptionLoggingFilter.html 947 2014-11-12 22:14:09Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.dellroad.stuff.servlet;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import java.io.IOException;<a name="line.10"></a>
<span class="sourceLineNo">011</span>import java.net.SocketException;<a name="line.11"></a>
<span class="sourceLineNo">012</span><a name="line.12"></a>
<span class="sourceLineNo">013</span>import javax.servlet.FilterChain;<a name="line.13"></a>
<span class="sourceLineNo">014</span>import javax.servlet.ServletException;<a name="line.14"></a>
<span class="sourceLineNo">015</span>import javax.servlet.http.HttpServletRequest;<a name="line.15"></a>
<span class="sourceLineNo">016</span>import javax.servlet.http.HttpServletResponse;<a name="line.16"></a>
<span class="sourceLineNo">017</span><a name="line.17"></a>
<span class="sourceLineNo">018</span>import org.slf4j.Logger;<a name="line.18"></a>
<span class="sourceLineNo">019</span>import org.slf4j.LoggerFactory;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import org.springframework.web.filter.OncePerRequestFilter;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>/**<a name="line.22"></a>
<span class="sourceLineNo">023</span> * Servlet filter that ensures any exceptions which are not handled by the servlet get logged somewhere.<a name="line.23"></a>
<span class="sourceLineNo">024</span> */<a name="line.24"></a>
<span class="sourceLineNo">025</span>public class ExceptionLoggingFilter extends OncePerRequestFilter {<a name="line.25"></a>
<span class="sourceLineNo">026</span><a name="line.26"></a>
<span class="sourceLineNo">027</span>    private final Logger defaultLogger = LoggerFactory.getLogger(this.getClass());<a name="line.27"></a>
<span class="sourceLineNo">028</span><a name="line.28"></a>
<span class="sourceLineNo">029</span>    /**<a name="line.29"></a>
<span class="sourceLineNo">030</span>     * Process the request. If an exception is thrown, it will be (possibly) logged and re-thrown.<a name="line.30"></a>
<span class="sourceLineNo">031</span>     *<a name="line.31"></a>
<span class="sourceLineNo">032</span>     * @see #shouldLogException shouldLogException()<a name="line.32"></a>
<span class="sourceLineNo">033</span>     */<a name="line.33"></a>
<span class="sourceLineNo">034</span>    @Override<a name="line.34"></a>
<span class="sourceLineNo">035</span>    public void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)<a name="line.35"></a>
<span class="sourceLineNo">036</span>      throws IOException, ServletException {<a name="line.36"></a>
<span class="sourceLineNo">037</span>        try {<a name="line.37"></a>
<span class="sourceLineNo">038</span>            filterChain.doFilter(request, response);<a name="line.38"></a>
<span class="sourceLineNo">039</span>        } catch (IOException e) {<a name="line.39"></a>
<span class="sourceLineNo">040</span>            if (this.shouldLogException(request, response, e))<a name="line.40"></a>
<span class="sourceLineNo">041</span>                this.logException(request, response, e);<a name="line.41"></a>
<span class="sourceLineNo">042</span>            throw e;<a name="line.42"></a>
<span class="sourceLineNo">043</span>        } catch (ServletException e) {<a name="line.43"></a>
<span class="sourceLineNo">044</span>            if (this.shouldLogException(request, response, e))<a name="line.44"></a>
<span class="sourceLineNo">045</span>                this.logException(request, response, e);<a name="line.45"></a>
<span class="sourceLineNo">046</span>            throw e;<a name="line.46"></a>
<span class="sourceLineNo">047</span>        } catch (RuntimeException e) {<a name="line.47"></a>
<span class="sourceLineNo">048</span>            if (this.shouldLogException(request, response, e))<a name="line.48"></a>
<span class="sourceLineNo">049</span>                this.logException(request, response, e);<a name="line.49"></a>
<span class="sourceLineNo">050</span>            throw e;<a name="line.50"></a>
<span class="sourceLineNo">051</span>        } catch (Error e) {<a name="line.51"></a>
<span class="sourceLineNo">052</span>            if (this.shouldLogException(request, response, e))<a name="line.52"></a>
<span class="sourceLineNo">053</span>                this.logException(request, response, e);<a name="line.53"></a>
<span class="sourceLineNo">054</span>            throw e;<a name="line.54"></a>
<span class="sourceLineNo">055</span>        } catch (Throwable e) {<a name="line.55"></a>
<span class="sourceLineNo">056</span>            if (this.shouldLogException(request, response, e))<a name="line.56"></a>
<span class="sourceLineNo">057</span>                this.logException(request, response, e);<a name="line.57"></a>
<span class="sourceLineNo">058</span>           throw new ServletException(e);<a name="line.58"></a>
<span class="sourceLineNo">059</span>        }<a name="line.59"></a>
<span class="sourceLineNo">060</span>    }<a name="line.60"></a>
<span class="sourceLineNo">061</span><a name="line.61"></a>
<span class="sourceLineNo">062</span>    /**<a name="line.62"></a>
<span class="sourceLineNo">063</span>     * Determine if an exception caught by this instance should be logged.<a name="line.63"></a>
<span class="sourceLineNo">064</span>     *<a name="line.64"></a>
<span class="sourceLineNo">065</span>     * &lt;p&gt;<a name="line.65"></a>
<span class="sourceLineNo">066</span>     * The implementation in {@link ExceptionLoggingFilter} returns {@code true} except for<a name="line.66"></a>
<span class="sourceLineNo">067</span>     * {@link SocketException} (typically caused by the client disconnecting) and {@link ThreadDeath}<a name="line.67"></a>
<span class="sourceLineNo">068</span>     * (typically caused by virtual machine shutdown). Subclasses should override if necessary.<a name="line.68"></a>
<span class="sourceLineNo">069</span>     * &lt;/p&gt;<a name="line.69"></a>
<span class="sourceLineNo">070</span>     *<a name="line.70"></a>
<span class="sourceLineNo">071</span>     * @param request HTTP request<a name="line.71"></a>
<span class="sourceLineNo">072</span>     * @param response HTTP response<a name="line.72"></a>
<span class="sourceLineNo">073</span>     * @param t exception caught by this instance<a name="line.73"></a>
<span class="sourceLineNo">074</span>     */<a name="line.74"></a>
<span class="sourceLineNo">075</span>    protected boolean shouldLogException(HttpServletRequest request, HttpServletResponse response, Throwable t) {<a name="line.75"></a>
<span class="sourceLineNo">076</span>        for (Throwable e = t; e != null; e = e.getCause()) {<a name="line.76"></a>
<span class="sourceLineNo">077</span>            if (e instanceof SocketException)<a name="line.77"></a>
<span class="sourceLineNo">078</span>                return false;<a name="line.78"></a>
<span class="sourceLineNo">079</span>            if (e.getClass().getName().equals("org.apache.catalina.connector.ClientAbortException"))<a name="line.79"></a>
<span class="sourceLineNo">080</span>                return false;<a name="line.80"></a>
<span class="sourceLineNo">081</span>            if (e instanceof ThreadDeath)<a name="line.81"></a>
<span class="sourceLineNo">082</span>                return false;<a name="line.82"></a>
<span class="sourceLineNo">083</span>        }<a name="line.83"></a>
<span class="sourceLineNo">084</span>        return true;<a name="line.84"></a>
<span class="sourceLineNo">085</span>    }<a name="line.85"></a>
<span class="sourceLineNo">086</span><a name="line.86"></a>
<span class="sourceLineNo">087</span>    /**<a name="line.87"></a>
<span class="sourceLineNo">088</span>     * Log an exception caught by this instance and determined to be loggable by {@link #shouldLogException shouldLogException()}.<a name="line.88"></a>
<span class="sourceLineNo">089</span>     *<a name="line.89"></a>
<span class="sourceLineNo">090</span>     * &lt;p&gt;<a name="line.90"></a>
<span class="sourceLineNo">091</span>     * The implementation in {@link ExceptionLoggingFilter} logs the exception as an error via the logger<a name="line.91"></a>
<span class="sourceLineNo">092</span>     * returned by {@link #getLogger getLogger()}. Subclasses should override if necessary.<a name="line.92"></a>
<span class="sourceLineNo">093</span>     * &lt;/p&gt;<a name="line.93"></a>
<span class="sourceLineNo">094</span>     *<a name="line.94"></a>
<span class="sourceLineNo">095</span>     * @param request HTTP request<a name="line.95"></a>
<span class="sourceLineNo">096</span>     * @param response HTTP response<a name="line.96"></a>
<span class="sourceLineNo">097</span>     * @param t exception caught by this instance<a name="line.97"></a>
<span class="sourceLineNo">098</span>     */<a name="line.98"></a>
<span class="sourceLineNo">099</span>    protected void logException(HttpServletRequest request, HttpServletResponse response, Throwable t) {<a name="line.99"></a>
<span class="sourceLineNo">100</span>        this.getLogger(request, response, t).error("exception within servlet", t);<a name="line.100"></a>
<span class="sourceLineNo">101</span>    }<a name="line.101"></a>
<span class="sourceLineNo">102</span><a name="line.102"></a>
<span class="sourceLineNo">103</span>    /**<a name="line.103"></a>
<span class="sourceLineNo">104</span>     * Get the logging destination.<a name="line.104"></a>
<span class="sourceLineNo">105</span>     *<a name="line.105"></a>
<span class="sourceLineNo">106</span>     * &lt;p&gt;<a name="line.106"></a>
<span class="sourceLineNo">107</span>     * The implementation in {@link ExceptionLoggingFilter} uses the {@link Logger} returned by<a name="line.107"></a>
<span class="sourceLineNo">108</span>     * {@link LoggerFactory#getLogger} when passed this instance's class as the parameter.<a name="line.108"></a>
<span class="sourceLineNo">109</span>     * Subclasses should override if necessary.<a name="line.109"></a>
<span class="sourceLineNo">110</span>     * &lt;/p&gt;<a name="line.110"></a>
<span class="sourceLineNo">111</span>     *<a name="line.111"></a>
<span class="sourceLineNo">112</span>     * @param request HTTP request<a name="line.112"></a>
<span class="sourceLineNo">113</span>     * @param response HTTP response<a name="line.113"></a>
<span class="sourceLineNo">114</span>     * @param t the exception about to be logged<a name="line.114"></a>
<span class="sourceLineNo">115</span>     */<a name="line.115"></a>
<span class="sourceLineNo">116</span>    protected Logger getLogger(HttpServletRequest request, HttpServletResponse response, Throwable t) {<a name="line.116"></a>
<span class="sourceLineNo">117</span>        return this.defaultLogger;<a name="line.117"></a>
<span class="sourceLineNo">118</span>    }<a name="line.118"></a>
<span class="sourceLineNo">119</span>}<a name="line.119"></a>
<span class="sourceLineNo">120</span><a name="line.120"></a>




























































</pre>
</div>
</body>
</html>
